home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cato / Xm / MrmFetchIconLiteral.z / MrmFetchIconLiteral
Text File  |  1998-10-20  |  7KB  |  133 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll - Fetches an icon literal from a
  10.           hierarchy
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<MMMMrrrrmmmm////MMMMrrrrmmmmPPPPuuuubbbblllliiiicccc....hhhh>>>>
  14.  
  15.           iiiinnnntttt MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((_h_i_e_r_a_r_c_h_y__i_d, _i_n_d_e_x, _s_c_r_e_e_n, _d_i_s_p_l_a_y, _f_g_p_i_x, _b_g_p_i_x, _p_i_x_m_a_p))))
  16.                MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy_h_i_e_r_a_r_c_h_y__i_d;;;;
  17.                SSSSttttrrrriiiinnnngggg    _i_n_d_e_x;;;;
  18.                SSSSccccrrrreeeeeeeennnn    ****_s_c_r_e_e_n;;;;
  19.                DDDDiiiissssppppllllaaaayyyy   ****_d_i_s_p_l_a_y;;;;
  20.                PPPPiiiixxxxeeeellll     _f_g_p_i_x;;;;
  21.                PPPPiiiixxxxeeeellll     _b_g_p_i_x;;;;
  22.                PPPPiiiixxxxmmmmaaaapppp    ****_p_i_x_m_a_p;;;;
  23.  
  24.  
  25.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  26.           This page documents version 1.2 of the Motif library.
  27.  
  28.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  29.           The MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll function fetches an icon literal
  30.           from an MRM hierarchy, and converts the icon literal to an X
  31.           pixmap.
  32.  
  33.  
  34.           _h_i_e_r_a_r_c_h_y__i_dSpecifies the ID of the UID hierarchy that
  35.                       contains the specified icon literal.  The
  36.                       _h_i_e_r_a_r_c_h_y__i_d was returned in a previous call to
  37.                       MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy.
  38.  
  39.           _i_n_d_e_x       Specifies the UIL name of the icon literal to
  40.                       fetch.
  41.  
  42.           _s_c_r_e_e_n      Specifies the screen used for the pixmap.  The
  43.                       _s_c_r_e_e_n argument specifies a pointer to the Xlib
  44.                       structure SSSSccccrrrreeeeeeeennnn which contains the information
  45.                       about that screen and is linked to the DDDDiiiissssppppllllaaaayyyy
  46.                       structure.  For more information on the DDDDiiiissssppppllllaaaayyyy
  47.                       and SSSSccccrrrreeeeeeeennnn structures, see the Xlib function
  48.                       XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy and the associated screen
  49.                       information macros.
  50.  
  51.           _d_i_s_p_l_a_y     Specifies the display used for the pixmap.  The
  52.                       _d_i_s_p_l_a_y argument specifies the connection to the
  53.                       X server.  For more information on the DDDDiiiissssppppllllaaaayyyy
  54.                       structure, see the Xlib function XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy.
  55.  
  56.           _f_g_p_i_x       Specifies the foreground color for the pixmap.
  57.  
  58.           _b_g_p_i_x       Specifies the background color for the pixmap.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   MMMMrrrrmmmmFFFFeeeettttcccchhhhIIIIccccoooonnnnLLLLiiiitttteeeerrrraaaallll((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           _p_i_x_m_a_p      Returns the resulting X pixmap value.
  75.  
  76.  
  77.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  78.           This function returns one of these status return constants:
  79.  
  80.  
  81.           MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS          The function executed successfully.
  82.  
  83.           MMMMrrrrmmmmBBBBAAAADDDD____HHHHIIIIEEEERRRRAAAARRRRCCCCHHHHYYYY    The hierarchy ID was invalid.
  84.  
  85.           MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD        The icon literal was not found in the
  86.                               hierarchy.
  87.  
  88.           MMMMrrrrmmmmWWWWRRRROOOONNNNGGGG____TTTTYYYYPPPPEEEE       The caller tried to fetch a literal of a
  89.                               type not supported by this function.
  90.  
  91.           MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE          The function failed.
  92.  
  93.  
  94.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  95.           MMMMrrrrmmmmFFFFeeeettttcccchhhhBBBBiiiittttmmmmaaaappppLLLLiiiitttteeeerrrraaaallll((((3333XXXX)))), MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))),
  96.           MMMMrrrrmmmmFFFFeeeettttcccchhhhLLLLiiiitttteeeerrrraaaallll((((3333XXXX)))), MMMMrrrrmmmmFFFFeeeettttcccchhhhCCCCoooolllloooorrrrLLLLiiiitttteeeerrrraaaallll((((3333XXXX)))), and
  97.           XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))).
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.